[Woo POS][Historical Orders] Orders Fetching #16036

staskus · 2025-08-25T19:10:25Z

Description

Infrastructure for remotely fetching required data from API, pagination, and in-memory cache. Implement a remote-first approach with the 25 most recent POS orders, automatic pagination when scrolling to the bottom, and in-memory caching for immediate display.

For consistency, I implemented a similar approach that we use with the items. This PR contains a lot of boilerplate, but I thought it's easier to do it in one go.

Service + Strategy + Controller + OrdersRemote combination. The strategy will be expanded with a search later.
Controller implements simple in-memory caching, refresh, and pagination
Created PointOfSaleOrdersModel since this view state is completely separate from the aggregate model (and wider POS)
Separate POS-only entities: POSOrder, POSOrderItem, POSOrderRefund
Dummy AI-generated UI for List and Details (it's out of scope for this PR, only for easier testing)

Steps to reproduce

Open POS -> Menu -> Orders
Confirm the loading state appears when orders are loading
Confirm correct POS orders are loaded, compare with wp-admin and Woo app orders
Confirm pull-to-refresh fetches new data
Confirm scrolling down triggers pagination
Close the orders view and reopen
Confirm cached data is immediately shown

UI is out of scope, generated to facilitate testing

Testing information

Tested on iPad Air M2 18.5 simulator

Screenshots

Order.List.and.Details.mov

I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

… pagination of POS orders

…dels

…ommon values

…ders

dangermattic · 2025-08-25T19:11:01Z

	1 Warning
⚠️	This PR is larger than 300 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.

Generated by 🚫 Danger

wpmobilebot · 2025-08-25T19:19:33Z

📲 You can test the changes from this Pull Request in WooCommerce iOS Prototype by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce iOS Prototype
	Build Number	`pr16036-7ff28cc`
	Version	`23.1`
	Bundle ID	`com.automattic.alpha.woocommerce`
	Commit	`7ff28cc`
	Installation URL	3i4b2h25qitio

Automatticians: You can use our internal self-serve MC tool to give yourself access to those builds if needed.

iamgabrielma · 2025-08-26T04:39:39Z

👋 I'll review this one later today, for the time being seems the test target won't compile:

Value of type 'any POSOrdersRemoteProtocol' has no member 'loadPOSOrders'

Periphery seems to complain as well but there is no output in buildkite, perhaps because of the build failure hitting before the scan. If needed objects can be marked with // periphery:ignore temporarily to pass CI.

staskus · 2025-08-26T06:28:10Z

@iamgabrielma yes, sorry! I need to get used to periphery. In these internal project PRs, I sometimes implement something that is supposed to be used in another PR but is not yet used now. I'll fix those warnings

…-fetching

…ta is loading

iamgabrielma

Works well and LGTM! Just left a couple of non-blocking comments.

✅ Confirm the loading state appears when orders are loading
✅ Confirm correct POS orders are loaded, compare with wp-admin and Woo app orders
✅ Confirm pull-to-refresh fetches new data
✅ Confirm scrolling down triggers pagination
✅ Close the orders view and reopen
✅ Confirm cached data is immediately shown

iamgabrielma · 2025-08-26T23:48:57Z

Modules/Sources/Yosemite/PointOfSale/Orders/PointOfSaleOrderService.swift

+import struct NetworkingCore.Order
+import protocol NetworkingCore.POSOrdersRemoteProtocol
+
+public final class PointOfSaleOrderService: PointOfSaleOrderServiceProtocol {


Just a thought, the naming of PointOfSaleOrderService is pretty similar to the existing POSOrderService and protocols which may lead to confusion. I have no specific suggestion at the moment, but I think we should start to differentiate them more, perhaps renaming to PointOfSaleOrdersService for now would suffice 🤔

Good point. We could call it OrderList{Controller/Service/etc..} so it would be as clear as possible...

iamgabrielma · 2025-08-26T23:53:56Z

Modules/Sources/Yosemite/PointOfSale/Orders/PointOfSaleOrderService.swift

+            return .init(items: posOrders,
+                        hasMorePages: pagedOrders.hasMorePages,
+                        totalItems: pagedOrders.totalItems)
+        } catch AFError.explicitlyCancelled {


TIL that we will separate these two, what's the use case for the request being explicitly cancelled? We may cancel it for performance/cache reasons?

It was more related to the search #15580, where inputting more letters would cancel the previous request. However, we don't want to show any error, so we explicitly handle and treat the request as successful.

iamgabrielma · 2025-08-26T23:59:30Z

WooCommerce/Classes/POS/Controllers/PointOfSaleOrdersController.swift

+    func loadNextOrders() async
+}
+
+@Observable final class PointOfSaleOrdersController: PointOfSaleOrdersControllerProtocol {


Same as above: PointOfSaleOrderController vs PointOfSaleOrdersController are pretty close

iamgabrielma · 2025-08-27T00:05:25Z

WooCommerce/Classes/POS/Presentation/Orders/PointOfSaleOrderDetailsView.swift

-        default:
-            return "Unknown Order"
-        }
+    @Environment(PointOfSaleOrdersModel.self) private var ordersModel


I'm curious about the usage of this model by injecting directly into the environment, rather than passing it through the aggregate model. Would you say it breaks the existing design or we should be fine to adopt it? Mainly asking because I tried the same approach for POS settings, but ultimately went through the aggregate model since I needed related services that were already injected.

PD: It could be just because UI is temporary, sorry if that's the case :D

Good question. I injected it separately because it didn't have any connection to the existing aggregate model. It looked like a completely different feature that depends on different kinds of information. Settings could be a different case since it makes sense that it shares dependencies with the main part of the POS.

iamgabrielma · 2025-08-27T00:09:40Z

WooCommerce/Classes/POS/Presentation/PointOfSaleEntryPointView.swift

    private let purchasableItemsSearchController: PointOfSaleSearchingItemsControllerProtocol
    private let couponsController: PointOfSaleCouponsControllerProtocol
    private let couponsSearchController: PointOfSaleSearchingItemsControllerProtocol
+    private let ordersController: PointOfSaleOrdersControllerProtocol


Same here with ordersController vs orderController, maybe makes sense to rename the original one in the sense of order creation, fulfilment, factory, ... and this one as order list? Naming is indeed a difficult problem 😅

Good points, I'll rename!

…-fetching

staskus added 12 commits August 25, 2025 15:11

Add loadPOSOrders to OrdersRemote

51e7e97

Create PointOfSaleOrderService for providing orders on POS

7b82d7e

Create PointOfSaleOrdersController for managing loading, refresh, and…

aa2642f

… pagination of POS orders

Add a simple in-memory cache for PointOfSaleOrdersController

7057b9c

Create POSOrder, POSOrderItem, POSOrderRefund to have separate POS mo…

1dfec4a

…dels

Create PointOfSaleOrderFetchStrategy

7ecdfb9

Use common fields in OrdersRemote since Order model expects all the c…

53e56c3

…ommon values

Inject PointOfSaleOrdersModel through entry point

97d5d08

Create PointOfSaleOrdersModel for managing order list state

54e6f75

Flatten OrderViewState

ca2713f

Update PointOfSaleOrdersControllerTests

b26a001

Create dummy UI for Order List and Details view for viewing loaded or…

8738475

…ders

staskus added this to the 23.2 milestone Aug 25, 2025

staskus requested review from iamgabrielma and toupper August 25, 2025 19:10

staskus added feature: POS type: task An internally driven task. labels Aug 25, 2025

iamgabrielma self-assigned this Aug 26, 2025

Update PointOfSaleOrderFetchStrategy.swift

34c7e0c

staskus marked this pull request as draft August 26, 2025 06:28

staskus and others added 2 commits August 26, 2025 09:52

Remove unused code

b6545a5

Merge branch 'trunk' into woomob-1131-woo-poshistorical-orders-orders…

c5c82eb

…-fetching

staskus marked this pull request as ready for review August 26, 2025 08:11

staskus added 3 commits August 26, 2025 15:30

Simplify new orders appending logic

73434ab

Add a loading indicator to POSPageHeaderView

b8423db

Display a small loading indicator when orders are cached but a new da…

acbb185

…ta is loading

iamgabrielma approved these changes Aug 27, 2025

View reviewed changes

staskus added 2 commits August 27, 2025 10:53

Rename PointOfSaleOrders to PointOfSaleOrderList

6f5e548

Merge branch 'trunk' into woomob-1131-woo-poshistorical-orders-orders…

7ff28cc

…-fetching

staskus merged commit 9d7f634 into trunk Aug 27, 2025
14 checks passed

staskus deleted the woomob-1131-woo-poshistorical-orders-orders-fetching branch August 27, 2025 10:05

[Woo POS][Historical Orders] Orders Fetching #16036

[Woo POS][Historical Orders] Orders Fetching #16036

Uh oh!

Conversation

staskus commented Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Steps to reproduce

Testing information

Screenshots

Uh oh!

dangermattic commented Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wpmobilebot commented Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iamgabrielma commented Aug 26, 2025

Uh oh!

staskus commented Aug 26, 2025

Uh oh!

iamgabrielma left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

staskus commented Aug 25, 2025 •

edited

Loading

dangermattic commented Aug 25, 2025 •

edited

Loading

wpmobilebot commented Aug 25, 2025 •

edited

Loading